Tangoe Mobile REST API
Dynamic Form Build-Out Hierarchy
This page gives the suggested hierarchy for building out dynamic forms for the activities New Line with Device and Device Upgrade.
NEW LINE
These are the individual API calls you will need to lookup in a hierarchical order for the activity_type_id = 3 payload.
/carriers
Your first call is to get all carriers that are scoped for the specific user by using their employee_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}
Query Parameter:
- employee_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/business_ref_devices
Your second call is to get all devices that are scoped to the specific user based on the carrier_id, activity_type_id, and employee_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/business_ref_devices?carrier_id={id}&activity_type_id={id}&employee_id={id}
Query Parameters:
- carrier_id
- activity_type_id
- employee_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/business_plans
Your third call will is to get all plans that are scoped to the specific user based on the carrier_id, activity_type_id, employee_id, and business_ref_device_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/business_plans?carrier_id={id}&activity_type_id={id}&employee_id={id}&business_ref_device_id={id}
Query Parameters:
- carrier_id
- activity_type_id
- employee_id or person_id
- business_ref_device_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/business_features
Your fourth call is to get all features that are scoped to the specific user based on the carrier_id, activity_type_id, employee_id, business_ref_device_id, and business_plan_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/business_features?carrier_id={id}&activity_type_id={id}&employee_id={id}&business_ref_device_id={id}&business_plan_id={id}
Query Parameters:
- carrier_id
- activity_type_id
- employee_id or person_id
- business_ref_device_id
- business_plan_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/accessories
Your last call will be to get all accessories (if any) that are scoped for the specific device.
Example URL: https:{subdomain}.thefutureis.mobi/1/accessories?business_ref_device_id={id}
Query Parameters:
- business_ref_device_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
Example Dynamic Form for a New Line with Device. The Postman GET Response is showing the IDs you will capture for each selection.
DEVICE UPGRADE
These are the individual API calls you will need to lookup in a hierarchical order for the activity_type_id = 17 payload.
/lines
Your first call is to get all lines that are scoped for the specific user.
Example URL: https:{subdomain}.thefutureis.mobi/1/lines?{query parameter}
Query Parameter:
- employee_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/business_ref_device
Your second call is to get all devices that are scoped to the specific user based on the carrier_id, activity_type_id, and employee_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/business_ref_devices?{query parameters}
Query Parameters:
- carrier_id
- activity_type_id
- employee_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/business_plans
Your third call will is to get all plans that are scoped to the specific user based on the carrier_id, activity_type_id, employee_id, and business_ref_device_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/business_plans?{query parameters}
Query Parameters:
- carrier_id
- activity_type_id
- employee_id or person_id
- business_ref_device_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json
/business_features
Your fourth call is to get all features that are scoped to the specific user based on the carrier_id, activity_type_id, employee_id, business_ref_device_id, and business_plan_id.
Example URL: https:{subdomain}.thefutureis.mobi/1/business_features?carrier_id={id}&
Query Parameters:
- carrier_id
- activity_type_id
- employee_id or person_id
- business_ref_device_id
- business_plan_id
Headers:
- Content-Type: application/json
- API-Token: your assigned token
- Accept: application/json